/*
 * Copyright 2012-2020 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.context.properties.source;

import java.util.List;
import java.util.function.BiPredicate;

import org.springframework.core.env.EnumerablePropertySource;
import org.springframework.core.env.PropertySource;

/**
 * 用于在 {@link PropertySource} 和 {@link ConfigurationPropertySource} 之间提供映射的策略。
 * <p>
 * 映射应同时支持 {@link ConfigurationPropertyName} 类型和基于 {@code String} 的名称。
 * 这样 {@link SpringConfigurationPropertySource} 可以优先尝试直接映射（即直接将 {@link ConfigurationPropertyName} 映射到 {@link PropertySource} 名称），
 * 如果失败则回退到通过枚举 {@link EnumerablePropertySource} 的属性名称，
 * 将其映射为 {@link ConfigurationPropertyName} 并检查适用性。
 * 详见 {@link SpringConfigurationPropertySource}。
 *
 * @author Phillip Webb
 * @author Madhura Bhave
 * @see SpringConfigurationPropertySource
 */
interface PropertyMapper {

	/**
	 * 默认的祖先关系检查方法。
	 */
	BiPredicate<ConfigurationPropertyName, ConfigurationPropertyName> DEFAULT_ANCESTOR_OF_CHECK = ConfigurationPropertyName::isAncestorOf;

	/**
	 * 提供从 {@link ConfigurationPropertySource} 的 {@link ConfigurationPropertyName} 到对应名称的映射。
	 * @param configurationPropertyName 要映射的名称
	 * @return 映射后的名称列表，若无则返回空列表
	 */
	List<String> map(ConfigurationPropertyName configurationPropertyName);

	/**
	 * 提供从 {@link PropertySource} 属性名称到 {@link ConfigurationPropertyName} 的映射。
	 * @param propertySourceName 要映射的属性名称
	 * @return 映射后的配置属性名称，若无则返回 {@link ConfigurationPropertyName#EMPTY}
	 */
	ConfigurationPropertyName map(String propertySourceName);

	/**
	 * 返回用于判断一个名称是否是另一个名称祖先的 {@link BiPredicate}，基于映射规则。
	 * @return 用于检查名称祖先关系的断言
	 */
	default BiPredicate<ConfigurationPropertyName, ConfigurationPropertyName> getAncestorOfCheck() {
		return DEFAULT_ANCESTOR_OF_CHECK;
	}

}
